\hypertarget{class_fluid_particle}{
\section{FluidParticle Class Reference}
\label{class_fluid_particle}\index{FluidParticle@{FluidParticle}}
}


stores all attributes for a fluid for use with SPH  




{\ttfamily \#include $<$FluidParticle.h$>$}



Inheritance diagram for FluidParticle:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=600pt]{class_fluid_particle__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for FluidParticle:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=600pt]{class_fluid_particle__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_fluid_particle_abb3aa8c0c3e7ed98696a49b04b0eb95d}{FluidParticle} ()
\begin{DoxyCompactList}\small\item\em ctor \end{DoxyCompactList}\item 
\hyperlink{class_fluid_particle_a4fef15b39baaa69f6b0bf50a37123396}{FluidParticle} (const \hyperlink{class_fluid_particle}{FluidParticle} \&\_\-fluidParticle)
\begin{DoxyCompactList}\small\item\em ctor \end{DoxyCompactList}\item 
\hyperlink{class_fluid_particle_a705923df6274889dbcb7ee7a88dc088f}{FluidParticle} (const int \_\-id, const ngl::Real \_\-mass=0, const ngl::Real \_\-density=0, const ngl::Vector \_\-position=0, const ngl::Vector \_\-velocity=0, const ngl::Real \_\-viscosityConstant=0, const ngl::Real \_\-gasConstant=0, const ngl::Real \_\-surfaceTensionCoefficient=0, const ngl::Real \_\-surfaceTensionThreshold=0, const ngl::Real \_\-surfaceColorCoefficient=0, const ngl::Real \_\-interfaceTensionCoefficient=0, const ngl::Real \_\-interfaceTensionThreshold=0, const ngl::Real \_\-interfaceColorCoefficient=0, const ngl::Colour \_\-colour=0, const ngl::Real \_\-radius=0, const std::string \_\-name=\char`\"{}na\char`\"{}, const bool \_\-waitUntilFirstHitBoundary=false, const bool \_\-waitUntilFirstHitRBD=false)
\begin{DoxyCompactList}\small\item\em ctor \end{DoxyCompactList}\item 
\hyperlink{class_fluid_particle_a5b00e708cb5123c8883b67168488da09}{$\sim$FluidParticle} ()
\begin{DoxyCompactList}\small\item\em dtor \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_add7cbd180dfd778365a1a59ce0fe9c05}{calculatePressure} ()
\begin{DoxyCompactList}\small\item\em calculate the scalar pressure \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a90079205a22d0defb825b92c1b9ad282}{resetForce} ()
\begin{DoxyCompactList}\small\item\em reset the accumulated force \end{DoxyCompactList}\item 
std::string \hyperlink{class_fluid_particle_a0c75715af37734d00ab61b57fbc0e591}{getName} () const 
\begin{DoxyCompactList}\small\item\em get the name of the fluid to which this particle belongs to \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_af1320742baea9749e69f29b6ab8c3ccd}{getPressureForce} () const 
\begin{DoxyCompactList}\small\item\em get the pressure force \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_adaada1140f6e607c71dcb2e13bb0b7b2}{setPressureForce} (const ngl::Vector \_\-f)
\begin{DoxyCompactList}\small\item\em set the pressure force \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_a7c5bec4da4095e8ea26bd2de436b2cc2}{getViscosityForce} () const 
\begin{DoxyCompactList}\small\item\em get the viscosity force \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_ab30ca5f5cc5586c3dd3fb308c08acc1b}{setViscosityForce} (const ngl::Vector \_\-f)
\begin{DoxyCompactList}\small\item\em set the viscosity force \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_a8c8125b381ee8f354bb38e199a865dfe}{getSurfaceTensionForce} () const 
\begin{DoxyCompactList}\small\item\em get the surface tension force \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_ad9b762aa99b14cabccacd09643d34d48}{setSurfaceTensionForce} (const ngl::Vector \_\-f)
\begin{DoxyCompactList}\small\item\em set the surface tension force \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_a87969914565f0dfe9885f2788ced39b7}{getInterfaceTensionForce} () const 
\begin{DoxyCompactList}\small\item\em get the interface tension force \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a8b6076e72161c65a7135a560005762be}{setInterfaceTensionForce} (const ngl::Vector \_\-f)
\begin{DoxyCompactList}\small\item\em set the interface tension force \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_aaf55f4024213da74d1e2ba1043b8bf5d}{getGravityForce} () const 
\begin{DoxyCompactList}\small\item\em get the gravitational force \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_acbefb444203e15e35ca457bd672f48dc}{setGravityForce} (const ngl::Vector \_\-f)
\begin{DoxyCompactList}\small\item\em set the gravitational force \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a19aa30ae4ba4f07f53fd3fa69b38b084}{getPressure} () const 
\begin{DoxyCompactList}\small\item\em get the pressure \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_ae46a808efdc6e4132ee84564fb644fab}{getDensity} () const 
\begin{DoxyCompactList}\small\item\em get the density \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_acdb806b3044bed4ca7cad4a65bfc6aea}{setDensity} (const ngl::Real \_\-d)
\begin{DoxyCompactList}\small\item\em set the density \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_ae890a3b7e4d3b8779f32abaf9038f905}{getMaterialRestDensity} () const 
\begin{DoxyCompactList}\small\item\em get the rest density \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a5f31da04c2a0229f4d09a2aff8c23f0f}{setMaterialRestDensity} (const ngl::Real \_\-v)
\begin{DoxyCompactList}\small\item\em set the rest density \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_ac9c1822921c77438883a033200243530}{getGasConstant} () const 
\begin{DoxyCompactList}\small\item\em get the gas constant \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a814b73436943fccc64939d1dc1c1945d}{setGasConstant} (const ngl::Real \_\-c)
\begin{DoxyCompactList}\small\item\em set the gas constant force \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_abff9703a289af1a52f478462bb92a4c3}{getViscosityConstant} () const 
\begin{DoxyCompactList}\small\item\em get the viscosity constant \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a2b75c09f28700e3cecc90adb4a667078}{setViscosityConstant} (const ngl::Real \_\-c)
\begin{DoxyCompactList}\small\item\em set the viscosity constant \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a5a4b8fee5183ee621b23f83644bfe434}{getSurfaceTensionCoefficient} () const 
\begin{DoxyCompactList}\small\item\em get the surface tension coefficient \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a82d3c0874ce805a3d9452566e7b3ef2c}{setSurfaceTensionCoefficient} (const ngl::Real \_\-c)
\begin{DoxyCompactList}\small\item\em set the surface interface coefficient \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a76ca06b896d9e30ac34ec6ba9c326835}{getSurfaceTensionThreshold} () const 
\begin{DoxyCompactList}\small\item\em get the surface tension threshold \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_aac6e5ce528890c6c4e22d770d07e1c6e}{setSurfaceTensionThreshold} (const ngl::Real \_\-c)
\begin{DoxyCompactList}\small\item\em set the surface tension threshold \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a367341528345883963d37185513a6983}{getSurfaceColorCoefficient} () const 
\begin{DoxyCompactList}\small\item\em get the surface tension color \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a70f87abd61f4e1d271e919ecd805a383}{setSurfaceColorCoefficient} (const ngl::Real \_\-c)
\begin{DoxyCompactList}\small\item\em set the surface color \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a2487accd86633f52afa8652a9d7b838e}{getInterfaceTensionCoefficient} () const 
\begin{DoxyCompactList}\small\item\em get the interface tension coefficient \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_ad749d39233e9db646184e2fe06a5b4e9}{setInterfaceTensionCoefficient} (const ngl::Real \_\-c)
\begin{DoxyCompactList}\small\item\em set the surface tension coefficient \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a95997fec4d4cc300fc327e4688ba3e40}{getInterfaceTensionThreshold} () const 
\begin{DoxyCompactList}\small\item\em get the interface tension threshold \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_ab8c99abb01bf95c5c99d732d20d399dc}{setInterfaceTensionThreshold} (const ngl::Real \_\-c)
\begin{DoxyCompactList}\small\item\em set the interface tension threshold \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_ab5fe54946c3926616b694fc8aee28fc8}{getInterfaceColorCoefficient} () const 
\begin{DoxyCompactList}\small\item\em get the interface tension color \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a05be01c87887e2fe9cee1e8703ce9160}{setInterfaceColorCoefficient} (const ngl::Real \_\-c)
\begin{DoxyCompactList}\small\item\em set the interface color \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_a50d17f46a207f2f475dbce99c9c058bd}{updateHitForTheFirstTime} (const bool \_\-hitBoundary, const bool \_\-hitRBD)
\begin{DoxyCompactList}\small\item\em update the properties of the particle to check when it can start behaving as a fluid \end{DoxyCompactList}\item 
bool \hyperlink{class_fluid_particle_ac17455d95027ce53ed050fb49cd42545}{fluidRulesEnabled} () const 
\begin{DoxyCompactList}\small\item\em check if particle can act as a fluid \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_abfa9f3c7fbb801e2038cf038a4edc099}{setWaitUntilFirstHitBoundary} (const bool \_\-v)
\begin{DoxyCompactList}\small\item\em set flag to determine if object can behave as a fluid when first hit the boundary \end{DoxyCompactList}\item 
void \hyperlink{class_fluid_particle_af96e8fe9caa17028964e90ae06cbbd0d}{setWaitUntilFirstHitRBD} (const bool \_\-v)
\begin{DoxyCompactList}\small\item\em set flag to determine if object can behave as a fluid when first hit the rbds \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
std::string \hyperlink{class_fluid_particle_a58aafd3376c4f7504b4b6a045d3b693e}{m\_\-name}
\begin{DoxyCompactList}\small\item\em name of fluid for identification by user later on \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_a0fc3f13aa67912329489ec7f3550af13}{m\_\-pressureForce}
\begin{DoxyCompactList}\small\item\em pressure force \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_a2118d5719ce2331efb1f3bc7c0650cfa}{m\_\-viscosityForce}
\begin{DoxyCompactList}\small\item\em viscosity force \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_ac2bbf04b2f814d332ed7dc5113472471}{m\_\-surfaceTensionForce}
\begin{DoxyCompactList}\small\item\em surface tension force \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_a1eed81ac818dc7d027490e912aa880c8}{m\_\-interfaceTensionForce}
\begin{DoxyCompactList}\small\item\em interface tension force \end{DoxyCompactList}\item 
ngl::Vector \hyperlink{class_fluid_particle_a4759c4e1e0729283a71dec834b753ae1}{m\_\-gravityForce}
\begin{DoxyCompactList}\small\item\em gravity force \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_ad2c0d1dae5fc90f4bbdce3ea51c6fb71}{m\_\-density}
\begin{DoxyCompactList}\small\item\em density at particle \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_ac9068123091facd5b7053ec2e39c8a9d}{m\_\-materialRestDensity}
\begin{DoxyCompactList}\small\item\em rest density at particle \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a58789d3f54a00cbde23c9fbe5fd8189c}{m\_\-pressure}
\begin{DoxyCompactList}\small\item\em pressure at particle \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a3788ca2bcafe18bf8bbf59faa0146385}{m\_\-viscosityConstant}
\begin{DoxyCompactList}\small\item\em viscosity constant \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a19ddab3f4dfe30378c11d3afa11a4708}{m\_\-gasConstant}
\begin{DoxyCompactList}\small\item\em gas constant \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a9b07a93d8ec041692c3ad99319c08939}{m\_\-surfaceTensionCoefficient}
\begin{DoxyCompactList}\small\item\em surface tension coefficient \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_aaa03e2d5786c38929e8e0546c08e950c}{m\_\-surfaceTensionThreshold}
\begin{DoxyCompactList}\small\item\em surface tension threshold \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a1bafc97f79f73eed857df1bbba79a3b8}{m\_\-surfaceColorCoefficient}
\begin{DoxyCompactList}\small\item\em surface color coefficient \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_ae649e3f7dcf63da1d3fb15c5c00c968d}{m\_\-interfaceTensionCoefficient}
\begin{DoxyCompactList}\small\item\em interface tension coefficient \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_a654e0edda2cb46780451fd98e0613211}{m\_\-interfaceTensionThreshold}
\begin{DoxyCompactList}\small\item\em interface tension threshold \end{DoxyCompactList}\item 
ngl::Real \hyperlink{class_fluid_particle_ab50ddf6727d5869c5732efe8a59b549d}{m\_\-interfaceColorCoefficient}
\begin{DoxyCompactList}\small\item\em interface color coefficient \end{DoxyCompactList}\item 
bool \hyperlink{class_fluid_particle_a287aea0e1898ee840ceefb82fe1cabcc}{m\_\-hasHitEnvironmentYet}
\begin{DoxyCompactList}\small\item\em flag to show whether the particle has hit the environment yet \end{DoxyCompactList}\item 
bool \hyperlink{class_fluid_particle_ab1daddf8c13eb734a84990bf356e3a4c}{m\_\-waitUntilFirstHitBoundary}
\begin{DoxyCompactList}\small\item\em flag to set whether particle wait until first hit the boundary before behaving as a fluid \end{DoxyCompactList}\item 
bool \hyperlink{class_fluid_particle_a1ad90103dd77de580c4954f521c046d7}{m\_\-waitUntilFirstHitRBD}
\begin{DoxyCompactList}\small\item\em flag to set whether particle wait until first hit the rbd before behaving as a fluid \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
stores all attributes for a fluid for use with SPH 

Definition at line 16 of file FluidParticle.h.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_fluid_particle_abb3aa8c0c3e7ed98696a49b04b0eb95d}{
\index{FluidParticle@{FluidParticle}!FluidParticle@{FluidParticle}}
\index{FluidParticle@{FluidParticle}!FluidParticle@{FluidParticle}}
\subsubsection[{FluidParticle}]{\setlength{\rightskip}{0pt plus 5cm}FluidParticle::FluidParticle (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{class_fluid_particle_abb3aa8c0c3e7ed98696a49b04b0eb95d}


ctor 



Definition at line 6 of file FluidParticle.cpp.


\begin{DoxyCode}
                             : Particle()
{
    FluidParticle(0);
}
\end{DoxyCode}
\hypertarget{class_fluid_particle_a4fef15b39baaa69f6b0bf50a37123396}{
\index{FluidParticle@{FluidParticle}!FluidParticle@{FluidParticle}}
\index{FluidParticle@{FluidParticle}!FluidParticle@{FluidParticle}}
\subsubsection[{FluidParticle}]{\setlength{\rightskip}{0pt plus 5cm}FluidParticle::FluidParticle (
\begin{DoxyParamCaption}
\item[{const {\bf FluidParticle} \&}]{\_\-fluidParticle}
\end{DoxyParamCaption}
)}}
\label{class_fluid_particle_a4fef15b39baaa69f6b0bf50a37123396}


ctor 



Definition at line 12 of file FluidParticle.cpp.



References getDensity(), getGasConstant(), getInterfaceColorCoefficient(), getInterfaceTensionCoefficient(), getInterfaceTensionThreshold(), getMaterialRestDensity(), getName(), getPressure(), getSurfaceColorCoefficient(), getSurfaceTensionCoefficient(), getSurfaceTensionThreshold(), getViscosityConstant(), m\_\-hasHitEnvironmentYet, m\_\-waitUntilFirstHitBoundary, and m\_\-waitUntilFirstHitRBD.


\begin{DoxyCode}
              :
            Particle
            (
                _particle.getId(),
                _particle.getMass(),
                _particle.getPosition(),
                _particle.getColour(),
                _particle.getRadius(),
                _particle.getMoveable(),
                _particle.getVelocity(),
                _particle.getAcceleration(),
                _particle.getNetForce()
            )
{
    m_name = _particle.getName();

    m_density = _particle.getDensity();
    m_materialRestDensity =_particle.getMaterialRestDensity();

    m_pressure = _particle.getPressure();

    m_viscosityConstant = _particle.getViscosityConstant();
    m_gasConstant = _particle.getGasConstant();

    m_surfaceTensionCoefficient = _particle.getSurfaceTensionCoefficient();
    m_surfaceTensionThreshold = _particle.getSurfaceTensionThreshold();
    m_surfaceColorCoefficient = _particle.getSurfaceColorCoefficient();

    m_interfaceTensionCoefficient = _particle.getInterfaceTensionCoefficient();
    m_interfaceTensionThreshold = _particle.getInterfaceTensionThreshold();
    m_interfaceColorCoefficient = _particle.getInterfaceColorCoefficient();

    m_hasHitEnvironmentYet = _particle.m_hasHitEnvironmentYet;
    m_waitUntilFirstHitBoundary = _particle.m_waitUntilFirstHitBoundary;
    m_waitUntilFirstHitRBD = _particle.m_waitUntilFirstHitRBD;
}
\end{DoxyCode}


Here is the call graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_a4fef15b39baaa69f6b0bf50a37123396_cgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a705923df6274889dbcb7ee7a88dc088f}{
\index{FluidParticle@{FluidParticle}!FluidParticle@{FluidParticle}}
\index{FluidParticle@{FluidParticle}!FluidParticle@{FluidParticle}}
\subsubsection[{FluidParticle}]{\setlength{\rightskip}{0pt plus 5cm}FluidParticle::FluidParticle (
\begin{DoxyParamCaption}
\item[{const int}]{\_\-id, }
\item[{const ngl::Real}]{\_\-mass = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-density = {\ttfamily 0}, }
\item[{const ngl::Vector}]{\_\-position = {\ttfamily 0}, }
\item[{const ngl::Vector}]{\_\-velocity = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-viscosityConstant = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-gasConstant = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-surfaceTensionCoefficient = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-surfaceTensionThreshold = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-surfaceColorCoefficient = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-interfaceTensionCoefficient = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-interfaceTensionThreshold = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-interfaceColorCoefficient = {\ttfamily 0}, }
\item[{const ngl::Colour}]{\_\-colour = {\ttfamily 0}, }
\item[{const ngl::Real}]{\_\-radius = {\ttfamily 0}, }
\item[{const std::string}]{\_\-name = {\ttfamily \char`\"{}na\char`\"{}}, }
\item[{const bool}]{\_\-waitUntilFirstHitBoundary = {\ttfamily false}, }
\item[{const bool}]{\_\-waitUntilFirstHitRBD = {\ttfamily false}}
\end{DoxyParamCaption}
)}}
\label{class_fluid_particle_a705923df6274889dbcb7ee7a88dc088f}


ctor 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-id} & the id \\
\hline
\mbox{\tt in}  & {\em \_\-mass} & the mass \\
\hline
\mbox{\tt in}  & {\em \_\-density} & the density \\
\hline
\mbox{\tt in}  & {\em \_\-position} & the position \\
\hline
\mbox{\tt in}  & {\em \_\-velocity} & the velocity \\
\hline
\mbox{\tt in}  & {\em \_\-viscosityConstant} & the viscosity constant \\
\hline
\mbox{\tt in}  & {\em \_\-gasConstant} & the gas constant \\
\hline
\mbox{\tt in}  & {\em \_\-surfaceTensionCoefficient} & the surface tension coefficient \\
\hline
\mbox{\tt in}  & {\em \_\-surfaceTensionThreshold} & the surface tension threshold \\
\hline
\mbox{\tt in}  & {\em \_\-surfaceColorCoefficient} & the surface tension color \\
\hline
\mbox{\tt in}  & {\em \_\-interfaceTensionCoefficient} & the interface tension coefficient \\
\hline
\mbox{\tt in}  & {\em \_\-interfaceTensionThreshold} & the interface tension threshold \\
\hline
\mbox{\tt in}  & {\em \_\-interfaceColorCoefficient} & the interface tension color \\
\hline
\mbox{\tt in}  & {\em \_\-colour} & the visual colour of the particle \\
\hline
\mbox{\tt in}  & {\em \_\-radius} & the radius \\
\hline
\mbox{\tt in}  & {\em \_\-name} & the name of the fluid to which this particle belongs \\
\hline
\mbox{\tt in}  & {\em \_\-waitUntilFirstHitBoundary} & flag to determine whether the particle hits boundary first before behaving as a fluid \\
\hline
\mbox{\tt in}  & {\em \_\-waitUntilFirstHitRBD} & flag to determine whether the particle hits rbd first before behaving as a fluid \\
\hline
\end{DoxyParams}


Definition at line 52 of file FluidParticle.cpp.


\begin{DoxyCode}
              :
            Particle(_id, _mass, _position, _colour, _radius, true, _velocity)
{
    //init params
    m_name = _name;

    m_density = _density;
    m_materialRestDensity = _density;

    m_pressure = 0;

    m_viscosityConstant = _viscosityConstant;
    m_gasConstant = _gasConstant;

    m_surfaceTensionCoefficient = _surfaceTensionCoefficient;
    m_surfaceTensionThreshold = _surfaceTensionThreshold;
    m_surfaceColorCoefficient = _surfaceColorCoefficient;

    m_interfaceTensionCoefficient = _interfaceTensionCoefficient;
    m_interfaceTensionThreshold = _interfaceTensionThreshold;
    m_interfaceColorCoefficient = _interfaceColorCoefficient;

    m_hasHitEnvironmentYet = false;
    m_waitUntilFirstHitBoundary = _waitUntilFirstHitBoundary;
    m_waitUntilFirstHitRBD = _waitUntilFirstHitRBD;
}
\end{DoxyCode}
\hypertarget{class_fluid_particle_a5b00e708cb5123c8883b67168488da09}{
\index{FluidParticle@{FluidParticle}!$\sim$FluidParticle@{$\sim$FluidParticle}}
\index{$\sim$FluidParticle@{$\sim$FluidParticle}!FluidParticle@{FluidParticle}}
\subsubsection[{$\sim$FluidParticle}]{\setlength{\rightskip}{0pt plus 5cm}FluidParticle::$\sim$FluidParticle (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{class_fluid_particle_a5b00e708cb5123c8883b67168488da09}


dtor 



Definition at line 98 of file FluidParticle.cpp.


\begin{DoxyCode}
{
}
\end{DoxyCode}


\subsection{Member Function Documentation}
\hypertarget{class_fluid_particle_add7cbd180dfd778365a1a59ce0fe9c05}{
\index{FluidParticle@{FluidParticle}!calculatePressure@{calculatePressure}}
\index{calculatePressure@{calculatePressure}!FluidParticle@{FluidParticle}}
\subsubsection[{calculatePressure}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::calculatePressure (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{class_fluid_particle_add7cbd180dfd778365a1a59ce0fe9c05}


calculate the scalar pressure 



Definition at line 102 of file FluidParticle.cpp.



References m\_\-density, m\_\-gasConstant, m\_\-materialRestDensity, and m\_\-pressure.


\begin{DoxyCode}
{
    //modified ideal gas state equation
    m_pressure = m_gasConstant * (m_density - m_materialRestDensity);
}
\end{DoxyCode}
\hypertarget{class_fluid_particle_ac17455d95027ce53ed050fb49cd42545}{
\index{FluidParticle@{FluidParticle}!fluidRulesEnabled@{fluidRulesEnabled}}
\index{fluidRulesEnabled@{fluidRulesEnabled}!FluidParticle@{FluidParticle}}
\subsubsection[{fluidRulesEnabled}]{\setlength{\rightskip}{0pt plus 5cm}bool FluidParticle::fluidRulesEnabled (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ac17455d95027ce53ed050fb49cd42545}


check if particle can act as a fluid 



Definition at line 196 of file FluidParticle.h.



References m\_\-hasHitEnvironmentYet, m\_\-waitUntilFirstHitBoundary, and m\_\-waitUntilFirstHitRBD.


\begin{DoxyCode}
{ return (m_waitUntilFirstHitBoundary || m_waitUntilFirstHitRBD) ? 
      m_hasHitEnvironmentYet : true; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_ae46a808efdc6e4132ee84564fb644fab}{
\index{FluidParticle@{FluidParticle}!getDensity@{getDensity}}
\index{getDensity@{getDensity}!FluidParticle@{FluidParticle}}
\subsubsection[{getDensity}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getDensity (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ae46a808efdc6e4132ee84564fb644fab}


get the density 



Definition at line 117 of file FluidParticle.h.



References m\_\-density.


\begin{DoxyCode}
{ return m_density; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_ae46a808efdc6e4132ee84564fb644fab_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_ac9c1822921c77438883a033200243530}{
\index{FluidParticle@{FluidParticle}!getGasConstant@{getGasConstant}}
\index{getGasConstant@{getGasConstant}!FluidParticle@{FluidParticle}}
\subsubsection[{getGasConstant}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getGasConstant (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ac9c1822921c77438883a033200243530}


get the gas constant 



Definition at line 131 of file FluidParticle.h.



References m\_\-gasConstant.


\begin{DoxyCode}
{ return m_gasConstant; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=396pt]{class_fluid_particle_ac9c1822921c77438883a033200243530_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_aaf55f4024213da74d1e2ba1043b8bf5d}{
\index{FluidParticle@{FluidParticle}!getGravityForce@{getGravityForce}}
\index{getGravityForce@{getGravityForce}!FluidParticle@{FluidParticle}}
\subsubsection[{getGravityForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector FluidParticle::getGravityForce (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_aaf55f4024213da74d1e2ba1043b8bf5d}


get the gravitational force 



Definition at line 107 of file FluidParticle.h.



References m\_\-gravityForce.


\begin{DoxyCode}
{ return m_gravityForce; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_ab5fe54946c3926616b694fc8aee28fc8}{
\index{FluidParticle@{FluidParticle}!getInterfaceColorCoefficient@{getInterfaceColorCoefficient}}
\index{getInterfaceColorCoefficient@{getInterfaceColorCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{getInterfaceColorCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getInterfaceColorCoefficient (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ab5fe54946c3926616b694fc8aee28fc8}


get the interface tension color 



Definition at line 180 of file FluidParticle.h.



References m\_\-interfaceColorCoefficient.


\begin{DoxyCode}
{ return m_interfaceColorCoefficient; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_ab5fe54946c3926616b694fc8aee28fc8_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a2487accd86633f52afa8652a9d7b838e}{
\index{FluidParticle@{FluidParticle}!getInterfaceTensionCoefficient@{getInterfaceTensionCoefficient}}
\index{getInterfaceTensionCoefficient@{getInterfaceTensionCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{getInterfaceTensionCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getInterfaceTensionCoefficient (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a2487accd86633f52afa8652a9d7b838e}


get the interface tension coefficient 



Definition at line 166 of file FluidParticle.h.



References m\_\-interfaceTensionCoefficient.


\begin{DoxyCode}
{ return m_interfaceTensionCoefficient; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_a2487accd86633f52afa8652a9d7b838e_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a87969914565f0dfe9885f2788ced39b7}{
\index{FluidParticle@{FluidParticle}!getInterfaceTensionForce@{getInterfaceTensionForce}}
\index{getInterfaceTensionForce@{getInterfaceTensionForce}!FluidParticle@{FluidParticle}}
\subsubsection[{getInterfaceTensionForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector FluidParticle::getInterfaceTensionForce (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a87969914565f0dfe9885f2788ced39b7}


get the interface tension force 



Definition at line 100 of file FluidParticle.h.



References m\_\-interfaceTensionForce.


\begin{DoxyCode}
{ return m_interfaceTensionForce; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a95997fec4d4cc300fc327e4688ba3e40}{
\index{FluidParticle@{FluidParticle}!getInterfaceTensionThreshold@{getInterfaceTensionThreshold}}
\index{getInterfaceTensionThreshold@{getInterfaceTensionThreshold}!FluidParticle@{FluidParticle}}
\subsubsection[{getInterfaceTensionThreshold}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getInterfaceTensionThreshold (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a95997fec4d4cc300fc327e4688ba3e40}


get the interface tension threshold 



Definition at line 173 of file FluidParticle.h.



References m\_\-interfaceTensionThreshold.


\begin{DoxyCode}
{ return m_interfaceTensionThreshold; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_a95997fec4d4cc300fc327e4688ba3e40_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_ae890a3b7e4d3b8779f32abaf9038f905}{
\index{FluidParticle@{FluidParticle}!getMaterialRestDensity@{getMaterialRestDensity}}
\index{getMaterialRestDensity@{getMaterialRestDensity}!FluidParticle@{FluidParticle}}
\subsubsection[{getMaterialRestDensity}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getMaterialRestDensity (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ae890a3b7e4d3b8779f32abaf9038f905}


get the rest density 



Definition at line 124 of file FluidParticle.h.



References m\_\-materialRestDensity.


\begin{DoxyCode}
{ return m_materialRestDensity; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_ae890a3b7e4d3b8779f32abaf9038f905_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a0c75715af37734d00ab61b57fbc0e591}{
\index{FluidParticle@{FluidParticle}!getName@{getName}}
\index{getName@{getName}!FluidParticle@{FluidParticle}}
\subsubsection[{getName}]{\setlength{\rightskip}{0pt plus 5cm}std::string FluidParticle::getName (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a0c75715af37734d00ab61b57fbc0e591}


get the name of the fluid to which this particle belongs to 



Definition at line 76 of file FluidParticle.h.



References m\_\-name.


\begin{DoxyCode}
{ return m_name; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=364pt]{class_fluid_particle_a0c75715af37734d00ab61b57fbc0e591_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a19aa30ae4ba4f07f53fd3fa69b38b084}{
\index{FluidParticle@{FluidParticle}!getPressure@{getPressure}}
\index{getPressure@{getPressure}!FluidParticle@{FluidParticle}}
\subsubsection[{getPressure}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getPressure (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a19aa30ae4ba4f07f53fd3fa69b38b084}


get the pressure 



Definition at line 114 of file FluidParticle.h.



References m\_\-pressure.


\begin{DoxyCode}
{ return m_pressure; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_a19aa30ae4ba4f07f53fd3fa69b38b084_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_af1320742baea9749e69f29b6ab8c3ccd}{
\index{FluidParticle@{FluidParticle}!getPressureForce@{getPressureForce}}
\index{getPressureForce@{getPressureForce}!FluidParticle@{FluidParticle}}
\subsubsection[{getPressureForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector FluidParticle::getPressureForce (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_af1320742baea9749e69f29b6ab8c3ccd}


get the pressure force 



Definition at line 79 of file FluidParticle.h.



References m\_\-pressureForce.


\begin{DoxyCode}
{ return m_pressureForce; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a367341528345883963d37185513a6983}{
\index{FluidParticle@{FluidParticle}!getSurfaceColorCoefficient@{getSurfaceColorCoefficient}}
\index{getSurfaceColorCoefficient@{getSurfaceColorCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{getSurfaceColorCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getSurfaceColorCoefficient (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a367341528345883963d37185513a6983}


get the surface tension color 



Definition at line 159 of file FluidParticle.h.



References m\_\-surfaceColorCoefficient.


\begin{DoxyCode}
{ return m_surfaceColorCoefficient; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_a367341528345883963d37185513a6983_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a5a4b8fee5183ee621b23f83644bfe434}{
\index{FluidParticle@{FluidParticle}!getSurfaceTensionCoefficient@{getSurfaceTensionCoefficient}}
\index{getSurfaceTensionCoefficient@{getSurfaceTensionCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{getSurfaceTensionCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getSurfaceTensionCoefficient (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a5a4b8fee5183ee621b23f83644bfe434}


get the surface tension coefficient 



Definition at line 145 of file FluidParticle.h.



References m\_\-surfaceTensionCoefficient.


\begin{DoxyCode}
{ return m_surfaceTensionCoefficient; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_a5a4b8fee5183ee621b23f83644bfe434_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a8c8125b381ee8f354bb38e199a865dfe}{
\index{FluidParticle@{FluidParticle}!getSurfaceTensionForce@{getSurfaceTensionForce}}
\index{getSurfaceTensionForce@{getSurfaceTensionForce}!FluidParticle@{FluidParticle}}
\subsubsection[{getSurfaceTensionForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector FluidParticle::getSurfaceTensionForce (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a8c8125b381ee8f354bb38e199a865dfe}


get the surface tension force 



Definition at line 93 of file FluidParticle.h.



References m\_\-surfaceTensionForce.


\begin{DoxyCode}
{ return m_surfaceTensionForce; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a76ca06b896d9e30ac34ec6ba9c326835}{
\index{FluidParticle@{FluidParticle}!getSurfaceTensionThreshold@{getSurfaceTensionThreshold}}
\index{getSurfaceTensionThreshold@{getSurfaceTensionThreshold}!FluidParticle@{FluidParticle}}
\subsubsection[{getSurfaceTensionThreshold}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getSurfaceTensionThreshold (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a76ca06b896d9e30ac34ec6ba9c326835}


get the surface tension threshold 



Definition at line 152 of file FluidParticle.h.



References m\_\-surfaceTensionThreshold.


\begin{DoxyCode}
{ return m_surfaceTensionThreshold; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_a76ca06b896d9e30ac34ec6ba9c326835_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_abff9703a289af1a52f478462bb92a4c3}{
\index{FluidParticle@{FluidParticle}!getViscosityConstant@{getViscosityConstant}}
\index{getViscosityConstant@{getViscosityConstant}!FluidParticle@{FluidParticle}}
\subsubsection[{getViscosityConstant}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real FluidParticle::getViscosityConstant (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_abff9703a289af1a52f478462bb92a4c3}


get the viscosity constant 



Definition at line 138 of file FluidParticle.h.



References m\_\-viscosityConstant.


\begin{DoxyCode}
{ return m_viscosityConstant; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_abff9703a289af1a52f478462bb92a4c3_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a7c5bec4da4095e8ea26bd2de436b2cc2}{
\index{FluidParticle@{FluidParticle}!getViscosityForce@{getViscosityForce}}
\index{getViscosityForce@{getViscosityForce}!FluidParticle@{FluidParticle}}
\subsubsection[{getViscosityForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector FluidParticle::getViscosityForce (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a7c5bec4da4095e8ea26bd2de436b2cc2}


get the viscosity force 



Definition at line 86 of file FluidParticle.h.



References m\_\-viscosityForce.


\begin{DoxyCode}
{ return m_viscosityForce; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a90079205a22d0defb825b92c1b9ad282}{
\index{FluidParticle@{FluidParticle}!resetForce@{resetForce}}
\index{resetForce@{resetForce}!FluidParticle@{FluidParticle}}
\subsubsection[{resetForce}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::resetForce (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{class_fluid_particle_a90079205a22d0defb825b92c1b9ad282}


reset the accumulated force 



Reimplemented from \hyperlink{class_particle_a9aa2597ad1c63ab4b5dd9ad0ecc9dc30}{Particle}.



Definition at line 108 of file FluidParticle.cpp.



References m\_\-gravityForce, m\_\-pressureForce, m\_\-surfaceTensionForce, and m\_\-viscosityForce.


\begin{DoxyCode}
{
    Particle::resetForce();

    m_pressureForce = 0;
    m_viscosityForce = 0;
    m_surfaceTensionForce = 0;
    m_gravityForce = 0;
}
\end{DoxyCode}
\hypertarget{class_fluid_particle_acdb806b3044bed4ca7cad4a65bfc6aea}{
\index{FluidParticle@{FluidParticle}!setDensity@{setDensity}}
\index{setDensity@{setDensity}!FluidParticle@{FluidParticle}}
\subsubsection[{setDensity}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setDensity (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-d}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_acdb806b3044bed4ca7cad4a65bfc6aea}


set the density 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-d} & density value \\
\hline
\end{DoxyParams}


Definition at line 121 of file FluidParticle.h.



References m\_\-density.


\begin{DoxyCode}
{ m_density = _d; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a814b73436943fccc64939d1dc1c1945d}{
\index{FluidParticle@{FluidParticle}!setGasConstant@{setGasConstant}}
\index{setGasConstant@{setGasConstant}!FluidParticle@{FluidParticle}}
\subsubsection[{setGasConstant}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setGasConstant (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-c}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a814b73436943fccc64939d1dc1c1945d}


set the gas constant force 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-c} & value \\
\hline
\end{DoxyParams}


Definition at line 135 of file FluidParticle.h.



References m\_\-gasConstant.


\begin{DoxyCode}
{ m_gasConstant = _c; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_acbefb444203e15e35ca457bd672f48dc}{
\index{FluidParticle@{FluidParticle}!setGravityForce@{setGravityForce}}
\index{setGravityForce@{setGravityForce}!FluidParticle@{FluidParticle}}
\subsubsection[{setGravityForce}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setGravityForce (
\begin{DoxyParamCaption}
\item[{const ngl::Vector}]{\_\-f}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_acbefb444203e15e35ca457bd672f48dc}


set the gravitational force 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-f} & force value \\
\hline
\end{DoxyParams}


Definition at line 111 of file FluidParticle.h.



References m\_\-gravityForce.


\begin{DoxyCode}
{ m_gravityForce = _f; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a05be01c87887e2fe9cee1e8703ce9160}{
\index{FluidParticle@{FluidParticle}!setInterfaceColorCoefficient@{setInterfaceColorCoefficient}}
\index{setInterfaceColorCoefficient@{setInterfaceColorCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{setInterfaceColorCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setInterfaceColorCoefficient (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-c}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a05be01c87887e2fe9cee1e8703ce9160}


set the interface color 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-c} & color value \\
\hline
\end{DoxyParams}


Definition at line 184 of file FluidParticle.h.



References m\_\-interfaceColorCoefficient.


\begin{DoxyCode}
{ m_interfaceColorCoefficient = _c; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_ad749d39233e9db646184e2fe06a5b4e9}{
\index{FluidParticle@{FluidParticle}!setInterfaceTensionCoefficient@{setInterfaceTensionCoefficient}}
\index{setInterfaceTensionCoefficient@{setInterfaceTensionCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{setInterfaceTensionCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setInterfaceTensionCoefficient (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-c}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ad749d39233e9db646184e2fe06a5b4e9}


set the surface tension coefficient 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-c} & coefficient value \\
\hline
\end{DoxyParams}


Definition at line 170 of file FluidParticle.h.



References m\_\-interfaceTensionCoefficient.


\begin{DoxyCode}
{ m_interfaceTensionCoefficient = _c; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a8b6076e72161c65a7135a560005762be}{
\index{FluidParticle@{FluidParticle}!setInterfaceTensionForce@{setInterfaceTensionForce}}
\index{setInterfaceTensionForce@{setInterfaceTensionForce}!FluidParticle@{FluidParticle}}
\subsubsection[{setInterfaceTensionForce}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setInterfaceTensionForce (
\begin{DoxyParamCaption}
\item[{const ngl::Vector}]{\_\-f}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a8b6076e72161c65a7135a560005762be}


set the interface tension force 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-f} & force value \\
\hline
\end{DoxyParams}


Definition at line 104 of file FluidParticle.h.



References m\_\-interfaceTensionForce.


\begin{DoxyCode}
{ m_interfaceTensionForce = _f; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_ab8c99abb01bf95c5c99d732d20d399dc}{
\index{FluidParticle@{FluidParticle}!setInterfaceTensionThreshold@{setInterfaceTensionThreshold}}
\index{setInterfaceTensionThreshold@{setInterfaceTensionThreshold}!FluidParticle@{FluidParticle}}
\subsubsection[{setInterfaceTensionThreshold}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setInterfaceTensionThreshold (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-c}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ab8c99abb01bf95c5c99d732d20d399dc}


set the interface tension threshold 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-c} & threshold value \\
\hline
\end{DoxyParams}


Definition at line 177 of file FluidParticle.h.



References m\_\-interfaceTensionThreshold.


\begin{DoxyCode}
{ m_interfaceTensionThreshold = _c; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a5f31da04c2a0229f4d09a2aff8c23f0f}{
\index{FluidParticle@{FluidParticle}!setMaterialRestDensity@{setMaterialRestDensity}}
\index{setMaterialRestDensity@{setMaterialRestDensity}!FluidParticle@{FluidParticle}}
\subsubsection[{setMaterialRestDensity}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setMaterialRestDensity (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a5f31da04c2a0229f4d09a2aff8c23f0f}


set the rest density 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-v} & density value \\
\hline
\end{DoxyParams}


Definition at line 128 of file FluidParticle.h.



References m\_\-materialRestDensity.


\begin{DoxyCode}
{ m_materialRestDensity = _v; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_adaada1140f6e607c71dcb2e13bb0b7b2}{
\index{FluidParticle@{FluidParticle}!setPressureForce@{setPressureForce}}
\index{setPressureForce@{setPressureForce}!FluidParticle@{FluidParticle}}
\subsubsection[{setPressureForce}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setPressureForce (
\begin{DoxyParamCaption}
\item[{const ngl::Vector}]{\_\-f}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_adaada1140f6e607c71dcb2e13bb0b7b2}


set the pressure force 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-f} & force value \\
\hline
\end{DoxyParams}


Definition at line 83 of file FluidParticle.h.



References m\_\-pressureForce.


\begin{DoxyCode}
{ m_pressureForce = _f; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a70f87abd61f4e1d271e919ecd805a383}{
\index{FluidParticle@{FluidParticle}!setSurfaceColorCoefficient@{setSurfaceColorCoefficient}}
\index{setSurfaceColorCoefficient@{setSurfaceColorCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{setSurfaceColorCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setSurfaceColorCoefficient (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-c}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a70f87abd61f4e1d271e919ecd805a383}


set the surface color 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-c} & color value \\
\hline
\end{DoxyParams}


Definition at line 163 of file FluidParticle.h.



References m\_\-surfaceColorCoefficient.


\begin{DoxyCode}
{ m_surfaceColorCoefficient = _c; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a82d3c0874ce805a3d9452566e7b3ef2c}{
\index{FluidParticle@{FluidParticle}!setSurfaceTensionCoefficient@{setSurfaceTensionCoefficient}}
\index{setSurfaceTensionCoefficient@{setSurfaceTensionCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{setSurfaceTensionCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setSurfaceTensionCoefficient (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-c}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a82d3c0874ce805a3d9452566e7b3ef2c}


set the surface interface coefficient 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-c} & coefficient value \\
\hline
\end{DoxyParams}


Definition at line 149 of file FluidParticle.h.



References m\_\-surfaceTensionCoefficient.


\begin{DoxyCode}
{ m_surfaceTensionCoefficient = _c; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_ad9b762aa99b14cabccacd09643d34d48}{
\index{FluidParticle@{FluidParticle}!setSurfaceTensionForce@{setSurfaceTensionForce}}
\index{setSurfaceTensionForce@{setSurfaceTensionForce}!FluidParticle@{FluidParticle}}
\subsubsection[{setSurfaceTensionForce}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setSurfaceTensionForce (
\begin{DoxyParamCaption}
\item[{const ngl::Vector}]{\_\-f}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ad9b762aa99b14cabccacd09643d34d48}


set the surface tension force 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-f} & force value \\
\hline
\end{DoxyParams}


Definition at line 97 of file FluidParticle.h.



References m\_\-surfaceTensionForce.


\begin{DoxyCode}
{ m_surfaceTensionForce = _f; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_aac6e5ce528890c6c4e22d770d07e1c6e}{
\index{FluidParticle@{FluidParticle}!setSurfaceTensionThreshold@{setSurfaceTensionThreshold}}
\index{setSurfaceTensionThreshold@{setSurfaceTensionThreshold}!FluidParticle@{FluidParticle}}
\subsubsection[{setSurfaceTensionThreshold}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setSurfaceTensionThreshold (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-c}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_aac6e5ce528890c6c4e22d770d07e1c6e}


set the surface tension threshold 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-c} & threshold value \\
\hline
\end{DoxyParams}


Definition at line 156 of file FluidParticle.h.



References m\_\-surfaceTensionThreshold.


\begin{DoxyCode}
{ m_surfaceTensionThreshold = _c; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_a2b75c09f28700e3cecc90adb4a667078}{
\index{FluidParticle@{FluidParticle}!setViscosityConstant@{setViscosityConstant}}
\index{setViscosityConstant@{setViscosityConstant}!FluidParticle@{FluidParticle}}
\subsubsection[{setViscosityConstant}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setViscosityConstant (
\begin{DoxyParamCaption}
\item[{const ngl::Real}]{\_\-c}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_a2b75c09f28700e3cecc90adb4a667078}


set the viscosity constant 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-c} & value \\
\hline
\end{DoxyParams}


Definition at line 142 of file FluidParticle.h.



References m\_\-viscosityConstant.


\begin{DoxyCode}
{ m_viscosityConstant = _c; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_ab30ca5f5cc5586c3dd3fb308c08acc1b}{
\index{FluidParticle@{FluidParticle}!setViscosityForce@{setViscosityForce}}
\index{setViscosityForce@{setViscosityForce}!FluidParticle@{FluidParticle}}
\subsubsection[{setViscosityForce}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setViscosityForce (
\begin{DoxyParamCaption}
\item[{const ngl::Vector}]{\_\-f}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_ab30ca5f5cc5586c3dd3fb308c08acc1b}


set the viscosity force 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-f} & force value \\
\hline
\end{DoxyParams}


Definition at line 90 of file FluidParticle.h.



References m\_\-viscosityForce.


\begin{DoxyCode}
{ m_viscosityForce = _f; }
\end{DoxyCode}
\hypertarget{class_fluid_particle_abfa9f3c7fbb801e2038cf038a4edc099}{
\index{FluidParticle@{FluidParticle}!setWaitUntilFirstHitBoundary@{setWaitUntilFirstHitBoundary}}
\index{setWaitUntilFirstHitBoundary@{setWaitUntilFirstHitBoundary}!FluidParticle@{FluidParticle}}
\subsubsection[{setWaitUntilFirstHitBoundary}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setWaitUntilFirstHitBoundary (
\begin{DoxyParamCaption}
\item[{const bool}]{\_\-v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_abfa9f3c7fbb801e2038cf038a4edc099}


set flag to determine if object can behave as a fluid when first hit the boundary 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-v} & flag value \\
\hline
\end{DoxyParams}


Definition at line 200 of file FluidParticle.h.



References m\_\-waitUntilFirstHitBoundary.


\begin{DoxyCode}
{ m_waitUntilFirstHitBoundary = _v; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_abfa9f3c7fbb801e2038cf038a4edc099_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_af96e8fe9caa17028964e90ae06cbbd0d}{
\index{FluidParticle@{FluidParticle}!setWaitUntilFirstHitRBD@{setWaitUntilFirstHitRBD}}
\index{setWaitUntilFirstHitRBD@{setWaitUntilFirstHitRBD}!FluidParticle@{FluidParticle}}
\subsubsection[{setWaitUntilFirstHitRBD}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::setWaitUntilFirstHitRBD (
\begin{DoxyParamCaption}
\item[{const bool}]{\_\-v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{class_fluid_particle_af96e8fe9caa17028964e90ae06cbbd0d}


set flag to determine if object can behave as a fluid when first hit the rbds 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-v} & flag value \\
\hline
\end{DoxyParams}


Definition at line 204 of file FluidParticle.h.



References m\_\-waitUntilFirstHitRBD.


\begin{DoxyCode}
{ m_waitUntilFirstHitRBD = _v; }
\end{DoxyCode}


Here is the caller graph for this function:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{class_fluid_particle_af96e8fe9caa17028964e90ae06cbbd0d_icgraph}
\end{center}
\end{figure}


\hypertarget{class_fluid_particle_a50d17f46a207f2f475dbce99c9c058bd}{
\index{FluidParticle@{FluidParticle}!updateHitForTheFirstTime@{updateHitForTheFirstTime}}
\index{updateHitForTheFirstTime@{updateHitForTheFirstTime}!FluidParticle@{FluidParticle}}
\subsubsection[{updateHitForTheFirstTime}]{\setlength{\rightskip}{0pt plus 5cm}void FluidParticle::updateHitForTheFirstTime (
\begin{DoxyParamCaption}
\item[{const bool}]{\_\-hitBoundary, }
\item[{const bool}]{\_\-hitRBD}
\end{DoxyParamCaption}
)}}
\label{class_fluid_particle_a50d17f46a207f2f475dbce99c9c058bd}


update the properties of the particle to check when it can start behaving as a fluid 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em \_\-hitBoundary} & flag to determine if object hit boundary \\
\hline
\mbox{\tt in}  & {\em \_\-hitRBD} & flag to determine if object hit rbd \\
\hline
\end{DoxyParams}


Definition at line 119 of file FluidParticle.cpp.


\begin{DoxyCode}
{
    //assume no hit for the first time
    bool hit1 = false;
    bool hit2 = false;

    //access hit status for both boundary and rbd
    if (m_waitUntilFirstHitBoundary && _hitBoundary )hit1 = true;
    if (m_waitUntilFirstHitRBD && _hitRBD )hit2 = true;

    //either boundary hit or rbd hit implies hit for the first time has occured
    m_hasHitEnvironmentYet = hit1 || hit2;
}
\end{DoxyCode}


\subsection{Member Data Documentation}
\hypertarget{class_fluid_particle_ad2c0d1dae5fc90f4bbdce3ea51c6fb71}{
\index{FluidParticle@{FluidParticle}!m\_\-density@{m\_\-density}}
\index{m\_\-density@{m\_\-density}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-density}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-density}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_ad2c0d1dae5fc90f4bbdce3ea51c6fb71}


density at particle 



Definition at line 226 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a19ddab3f4dfe30378c11d3afa11a4708}{
\index{FluidParticle@{FluidParticle}!m\_\-gasConstant@{m\_\-gasConstant}}
\index{m\_\-gasConstant@{m\_\-gasConstant}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-gasConstant}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-gasConstant}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a19ddab3f4dfe30378c11d3afa11a4708}


gas constant 



Definition at line 238 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a4759c4e1e0729283a71dec834b753ae1}{
\index{FluidParticle@{FluidParticle}!m\_\-gravityForce@{m\_\-gravityForce}}
\index{m\_\-gravityForce@{m\_\-gravityForce}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-gravityForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector {\bf FluidParticle::m\_\-gravityForce}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a4759c4e1e0729283a71dec834b753ae1}


gravity force 



Definition at line 223 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a287aea0e1898ee840ceefb82fe1cabcc}{
\index{FluidParticle@{FluidParticle}!m\_\-hasHitEnvironmentYet@{m\_\-hasHitEnvironmentYet}}
\index{m\_\-hasHitEnvironmentYet@{m\_\-hasHitEnvironmentYet}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-hasHitEnvironmentYet}]{\setlength{\rightskip}{0pt plus 5cm}bool {\bf FluidParticle::m\_\-hasHitEnvironmentYet}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a287aea0e1898ee840ceefb82fe1cabcc}


flag to show whether the particle has hit the environment yet 



Definition at line 259 of file FluidParticle.h.

\hypertarget{class_fluid_particle_ab50ddf6727d5869c5732efe8a59b549d}{
\index{FluidParticle@{FluidParticle}!m\_\-interfaceColorCoefficient@{m\_\-interfaceColorCoefficient}}
\index{m\_\-interfaceColorCoefficient@{m\_\-interfaceColorCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-interfaceColorCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-interfaceColorCoefficient}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_ab50ddf6727d5869c5732efe8a59b549d}


interface color coefficient 



Definition at line 256 of file FluidParticle.h.

\hypertarget{class_fluid_particle_ae649e3f7dcf63da1d3fb15c5c00c968d}{
\index{FluidParticle@{FluidParticle}!m\_\-interfaceTensionCoefficient@{m\_\-interfaceTensionCoefficient}}
\index{m\_\-interfaceTensionCoefficient@{m\_\-interfaceTensionCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-interfaceTensionCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-interfaceTensionCoefficient}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_ae649e3f7dcf63da1d3fb15c5c00c968d}


interface tension coefficient 



Definition at line 250 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a1eed81ac818dc7d027490e912aa880c8}{
\index{FluidParticle@{FluidParticle}!m\_\-interfaceTensionForce@{m\_\-interfaceTensionForce}}
\index{m\_\-interfaceTensionForce@{m\_\-interfaceTensionForce}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-interfaceTensionForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector {\bf FluidParticle::m\_\-interfaceTensionForce}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a1eed81ac818dc7d027490e912aa880c8}


interface tension force 



Definition at line 220 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a654e0edda2cb46780451fd98e0613211}{
\index{FluidParticle@{FluidParticle}!m\_\-interfaceTensionThreshold@{m\_\-interfaceTensionThreshold}}
\index{m\_\-interfaceTensionThreshold@{m\_\-interfaceTensionThreshold}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-interfaceTensionThreshold}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-interfaceTensionThreshold}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a654e0edda2cb46780451fd98e0613211}


interface tension threshold 



Definition at line 253 of file FluidParticle.h.

\hypertarget{class_fluid_particle_ac9068123091facd5b7053ec2e39c8a9d}{
\index{FluidParticle@{FluidParticle}!m\_\-materialRestDensity@{m\_\-materialRestDensity}}
\index{m\_\-materialRestDensity@{m\_\-materialRestDensity}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-materialRestDensity}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-materialRestDensity}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_ac9068123091facd5b7053ec2e39c8a9d}


rest density at particle 



Definition at line 229 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a58aafd3376c4f7504b4b6a045d3b693e}{
\index{FluidParticle@{FluidParticle}!m\_\-name@{m\_\-name}}
\index{m\_\-name@{m\_\-name}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-name}]{\setlength{\rightskip}{0pt plus 5cm}std::string {\bf FluidParticle::m\_\-name}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a58aafd3376c4f7504b4b6a045d3b693e}


name of fluid for identification by user later on 



Definition at line 208 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a58789d3f54a00cbde23c9fbe5fd8189c}{
\index{FluidParticle@{FluidParticle}!m\_\-pressure@{m\_\-pressure}}
\index{m\_\-pressure@{m\_\-pressure}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-pressure}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-pressure}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a58789d3f54a00cbde23c9fbe5fd8189c}


pressure at particle 



Definition at line 232 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a0fc3f13aa67912329489ec7f3550af13}{
\index{FluidParticle@{FluidParticle}!m\_\-pressureForce@{m\_\-pressureForce}}
\index{m\_\-pressureForce@{m\_\-pressureForce}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-pressureForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector {\bf FluidParticle::m\_\-pressureForce}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a0fc3f13aa67912329489ec7f3550af13}


pressure force 



Definition at line 211 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a1bafc97f79f73eed857df1bbba79a3b8}{
\index{FluidParticle@{FluidParticle}!m\_\-surfaceColorCoefficient@{m\_\-surfaceColorCoefficient}}
\index{m\_\-surfaceColorCoefficient@{m\_\-surfaceColorCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-surfaceColorCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-surfaceColorCoefficient}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a1bafc97f79f73eed857df1bbba79a3b8}


surface color coefficient 



Definition at line 247 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a9b07a93d8ec041692c3ad99319c08939}{
\index{FluidParticle@{FluidParticle}!m\_\-surfaceTensionCoefficient@{m\_\-surfaceTensionCoefficient}}
\index{m\_\-surfaceTensionCoefficient@{m\_\-surfaceTensionCoefficient}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-surfaceTensionCoefficient}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-surfaceTensionCoefficient}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a9b07a93d8ec041692c3ad99319c08939}


surface tension coefficient 



Definition at line 241 of file FluidParticle.h.

\hypertarget{class_fluid_particle_ac2bbf04b2f814d332ed7dc5113472471}{
\index{FluidParticle@{FluidParticle}!m\_\-surfaceTensionForce@{m\_\-surfaceTensionForce}}
\index{m\_\-surfaceTensionForce@{m\_\-surfaceTensionForce}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-surfaceTensionForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector {\bf FluidParticle::m\_\-surfaceTensionForce}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_ac2bbf04b2f814d332ed7dc5113472471}


surface tension force 



Definition at line 217 of file FluidParticle.h.

\hypertarget{class_fluid_particle_aaa03e2d5786c38929e8e0546c08e950c}{
\index{FluidParticle@{FluidParticle}!m\_\-surfaceTensionThreshold@{m\_\-surfaceTensionThreshold}}
\index{m\_\-surfaceTensionThreshold@{m\_\-surfaceTensionThreshold}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-surfaceTensionThreshold}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-surfaceTensionThreshold}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_aaa03e2d5786c38929e8e0546c08e950c}


surface tension threshold 



Definition at line 244 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a3788ca2bcafe18bf8bbf59faa0146385}{
\index{FluidParticle@{FluidParticle}!m\_\-viscosityConstant@{m\_\-viscosityConstant}}
\index{m\_\-viscosityConstant@{m\_\-viscosityConstant}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-viscosityConstant}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Real {\bf FluidParticle::m\_\-viscosityConstant}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a3788ca2bcafe18bf8bbf59faa0146385}


viscosity constant 



Definition at line 235 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a2118d5719ce2331efb1f3bc7c0650cfa}{
\index{FluidParticle@{FluidParticle}!m\_\-viscosityForce@{m\_\-viscosityForce}}
\index{m\_\-viscosityForce@{m\_\-viscosityForce}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-viscosityForce}]{\setlength{\rightskip}{0pt plus 5cm}ngl::Vector {\bf FluidParticle::m\_\-viscosityForce}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a2118d5719ce2331efb1f3bc7c0650cfa}


viscosity force 



Definition at line 214 of file FluidParticle.h.

\hypertarget{class_fluid_particle_ab1daddf8c13eb734a84990bf356e3a4c}{
\index{FluidParticle@{FluidParticle}!m\_\-waitUntilFirstHitBoundary@{m\_\-waitUntilFirstHitBoundary}}
\index{m\_\-waitUntilFirstHitBoundary@{m\_\-waitUntilFirstHitBoundary}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-waitUntilFirstHitBoundary}]{\setlength{\rightskip}{0pt plus 5cm}bool {\bf FluidParticle::m\_\-waitUntilFirstHitBoundary}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_ab1daddf8c13eb734a84990bf356e3a4c}


flag to set whether particle wait until first hit the boundary before behaving as a fluid 



Definition at line 262 of file FluidParticle.h.

\hypertarget{class_fluid_particle_a1ad90103dd77de580c4954f521c046d7}{
\index{FluidParticle@{FluidParticle}!m\_\-waitUntilFirstHitRBD@{m\_\-waitUntilFirstHitRBD}}
\index{m\_\-waitUntilFirstHitRBD@{m\_\-waitUntilFirstHitRBD}!FluidParticle@{FluidParticle}}
\subsubsection[{m\_\-waitUntilFirstHitRBD}]{\setlength{\rightskip}{0pt plus 5cm}bool {\bf FluidParticle::m\_\-waitUntilFirstHitRBD}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{class_fluid_particle_a1ad90103dd77de580c4954f521c046d7}


flag to set whether particle wait until first hit the rbd before behaving as a fluid 



Definition at line 265 of file FluidParticle.h.



The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
include/\hyperlink{_fluid_particle_8h}{FluidParticle.h}\item 
src/\hyperlink{_fluid_particle_8cpp}{FluidParticle.cpp}\end{DoxyCompactItemize}
